home *** CD-ROM | disk | FTP | other *** search
/ Windows Expert / Windows Expert.iso / desktop / qcdrun1a.zip / QCDD.EXE / QLIB.TXT < prev    next >
Text File  |  1993-01-21  |  16KB  |  330 lines
  1. QLIB.TXT :                             Copyright 1993 QUART, Inc.
  2.  
  3. Users' Manual for QLIB.EXE - QCDRUN (TM) CD-ROM Database Editor
  4.              
  5.         QCDRUN CD-ROM Library System for Microsoft Windows is a 
  6. database management utility and automatic CD-ROM launcher for the 
  7. Windows Multimedia and CD-ROM user with an extensive library of
  8. CD-ROMs. QCDRUN gives you true click-and-load convenience. 
  9.  
  10.         QLIB.EXE creates and edits the master database files that
  11. allow QCD and the other programs of the QCDRUN system to identify 
  12. and run CD-ROMs from catalogued information. QLIB can run as a
  13. standalone Windows application, and will be called by QCD if it 
  14. cannot identify the CD-ROM currently in the drive. 
  15.  
  16.         All QCDRUN programs automatically locate the main Windows 
  17. working directory on your hard drive and search there for .PIF and 
  18. .INI files and major Windows operational files. Certain operating 
  19. options in QCDRUN rely on the availability of the Windows utilities 
  20. WINFILE (File Manager), WRITE (for on-screen filling out and printing 
  21. of the registration form), and NOTEPAD (to read documentation), in 
  22. your main Windows working directory. These functions will not operate 
  23. correctly if these utilities are absent or located elsewhere. 
  24.  
  25.         QLIB accepts data base information from direct keyboard 
  26. entry or from selection menus and saves this in two database files - 
  27. QCD.INI in your Windows directory, and CDLIST.INI in the QCDRUN 
  28. working directory. QLIB can shell at your request to QDOC to read 
  29. documentation and write registration forms.       
  30.  
  31.         QLIB : Initial Operation:
  32.  
  33. a.      From Windows Program Manager menu - select File Run
  34.  
  35. b.      Enter the Command Line  h:\dir\qlib, where h is your working 
  36. hard drive; and dir is the working directory containing the QCDRUN
  37. system. (Default path is c:\qcd.) If you have installed the QCDRUN 
  38. working directory into your DOS path, you need only enter QLIB at 
  39. the File Run command line.
  40.  
  41. c.       Press ENTER (from the keyboard) or click OK (left mouse button)
  42.  
  43.  
  44.         QLIB : General Instructions and Operations
  45.  
  46. Please be aware:        
  47.  
  48.         At any prompt in QLIB - Clicking "Cancel" unconditionally  
  49. terminates the program.
  50.  
  51.         To accept defaults (when shown in prompts) - press "ENTER" 
  52. or click "OK"
  53.  
  54.         To change from defaults - enter from the keyboard, then 
  55. press "ENTER" or click "OK"
  56.  
  57.         All mouse operations in QLIB use the (standard) left mouse 
  58. button.
  59.  
  60.         Any timed Message or Display window (without an "OK" button) 
  61. can be closed, allowing the program to continue before the set time
  62. (which is a maximum of 5 seconds), by placing the cursor in the window
  63. and clicking the left mouse button. 
  64.  
  65.  
  66.  
  67. Step by step:
  68.  
  69. PRELIMINARY TESTING:
  70.  
  71. a.      QLIB opens with a copyright notice that clears in 5 seconds.
  72.  
  73. b.      QLIB tests for installation in WIN.INI. If you try to simply
  74. copy the QCDRUN distribution files to your hard drive and run QLIB 
  75. without completing the QINSTALL procedure, QCD and QLIB will not 
  76. find the appropriate entries in WIN.INI or the QCD.INI file, and 
  77. will be unable to operate. If the {QCD} section is not present in 
  78. WIN.INI, QLIB tells you to run QINSTALL and terminates.
  79.  
  80. FILE BACKUP and DOCUMENTATION VIEWER:
  81.  
  82. c.      QLIB makes backup copies of existing CD-ROM library files
  83. QCD.INI and CDLIST.INI in the QCDRUN working directory. QLIB then 
  84. shells out to QDOC to allow you to view or print program documentation 
  85. (click "Yes"). This also allows you to generate your Registration Form 
  86. on-screen. If you do not wish to view or print out documentation but 
  87. wish to continue in QLIB and edit a CD-ROM, click "No" and QLIB will 
  88. resume.
  89.  
  90. EDITING FUNCTIONS:
  91.  
  92. d.      QLIB performs three basic database operations:
  93.                 - install new CD-ROM;
  94.                 - edit existing installation; and
  95.                 - uninstall CD-ROM.
  96.                 
  97.         Successful installation of new CD-ROMs or editing of existing
  98. installations requires that the CD-ROM in question be present in the 
  99. CD-ROM drive.        
  100.  
  101.         In setting up the database structure in QCD.INI, QLIB 
  102. recognizes four basic types of CD-ROM, each of which is handled 
  103. slightly differently:
  104.  
  105.                 1.      CD-ROM runs from single executable file
  106.                            (example - PC-SIG Library edition 11);
  107.                 2.      CD-ROM runs from several executable files
  108.                            (example - CorelDraw version 3.0);
  109.                 3.      CD-ROM contains a mixture of executable 
  110.                   files and archived files that must be accessed 
  111.                   directly  (example - HamCall); and
  112.                 4.      CD-ROM contains archived files only with 
  113.                   no executable files or shell (example - GIFs Galore).
  114.  
  115.         In each case, the executable file may run from the CD-ROM 
  116. itself, may have been installed previously on your hard drive, or 
  117. may (rarely) require a floppy disk. Additionally, the executable 
  118. file may run appropriately after a command consisting of path:\filename 
  119. only, or may require specification or additional parameters. All 
  120. these possibilities are acceptable in QLIB.                                                
  121.  
  122.  
  123. INSTALLING A NEW CD-ROM:
  124.  
  125. e.      Information on a new CD-ROM will normally be appended to 
  126. the end of QCD.INI, increasing the total number of CDs included in 
  127. the library by 1. However, if a CD-ROM has previously been deleted 
  128. from the library, its place in  numerical sequence is held (the 
  129. [CDTitle] section of QCD.INI, and CDLIST.INI, both contain the 
  130. word "Deleted" at that number in sequence; see below for further
  131. details or the CD-ROM deletion process). In that case, the next new
  132. installation will take the place in numerical sequence of the deleted
  133. CD-ROM and the index for the total number of CD-ROMs in the library
  134. (NCD in the [main] section of QCD.INI) will not be incremented.
  135.  
  136. f.      QLIB requires the CD-ROM to be installed in the CD-ROM 
  137. drive. It will ask for confirmation that the correct CD-ROM is in
  138. place, and will prompt for a change and eject the current CD-ROM
  139. (if drive design permits) if the CD-ROM for installation is not in
  140. place. (In many systems, ejecting the CD-ROM may produce an "Unable 
  141. to Read Drive" System Error message that clears by clicking "Retry" 
  142. after the new CD-ROM is inserted.) 
  143.  
  144. g.      Many CD-ROMs (especially those that are DOS-based rather 
  145. than native Windows applications) require separate and unique setup 
  146. procedures to copy files from (usually) the CD-ROM or (rarely) a 
  147. floppy disk onto your hard drive to allow the CD-ROM to run. QLIB 
  148. asks if you need to run the CD-ROMs setup procedure. In all cases 
  149. where this is necessary, this should be completed before the QLIB 
  150. database is established. (You don't need to if you've completed 
  151. setting up the CD-ROM before running QLIB, if the CD-ROM is archival 
  152. only with no executable files, or if the CD-ROM executable files 
  153. explicitly require no specific setup.) A menu shell appears at this 
  154. point to allow you to run the CD-ROM's setup routines without 
  155. leaving QLIB. Answering the questions, you create the installation 
  156. directory for the CD-ROM; and select the setup path, program, and 
  157. additional parameters from the files on the CD-ROM. When this is 
  158. complete, QLIB will run the setup procedures to install the 
  159. CD-ROM to your hard drive before continuing with the QLIB database 
  160. functions. (Note that many CD-ROM's have unusual or unique setup 
  161. procedures. Some,  especially those that shell from Windows to DOS, 
  162. may conflict unpredictably with QLIB or your Windows system. While 
  163. the CD-ROM setup procedure from within QLIB is convenient, it may 
  164. prove unstable. If time permits you are better off running the 
  165. CD-ROM setup procedures before entering QLIB; OR exiting QLIB 
  166. at this point, performing the setup, and returning to QLIB for 
  167. database management only.)
  168.  
  169. h.      QLIB then prompts for entry of a working title for the 
  170. CD-ROM. This will be recorded in the CD-ROM library file QCD.INI 
  171. section [CDTitle] and in CDLIST.INI and be used as the name or 
  172. title by which the CD-ROM is normally referred to. A blank entry 
  173. is not acceptable.
  174.  
  175. i.      QLIB then creates a shell of subdirectories and files
  176. on the CD-ROM to allow you select a single file on the CD-ROM that
  177. will be recorded in QCD.INI and used by QCD as a unique identifier
  178. for the CD-ROM. You may select any file from any subdirectory - but
  179. are best to select a subdirectory and file that are unlikely to be
  180. found on another CD-ROM. Blank entries are not acceptable. Before
  181. accepting the identifier file, QLIB scans QCD.INI to ensure that no
  182. other CD-ROM is using a file of the same path and name as its
  183. identifier. If a file of the same path and name IS found in QCD.INI,
  184. QLIB generates an error message ("Identifier File is Not Unique") 
  185. and returns to the file shell menus to allow selection of another
  186. identifier file.
  187.  
  188. j.      QLIB then asks you to select from a menu to identify the 
  189. CD-ROM as one of the four basic types (see d. above). QLIB operation 
  190. from this point on varies slightly according to the CD-ROM type.
  191.       
  192. k.      If the CD-ROM runs from a single executable file, QLIB asks
  193. if the CD-ROM is a native Windows application. If not, it advises 
  194. you to select from existing Windows .PIF file or to create a new 
  195. Windows .PIF file for best application execution. If an existing
  196. .PIF file is available, QLIB shows a menu shell to allow its selection. 
  197. If you wish to create a new .PIF file, QLIB shells to the Windows
  198. .PIF editor to allow you to create it and automatically accepts 
  199. that new file name as the path and file name for the CD-ROM executable
  200. file. If you do not use a .PIF file at this time, or if this is a 
  201. native Windows application, QLIB prompts you to enter the path and 
  202. file name for the file. This is a mandatory entry. You are then 
  203. prompted to enter any optional parameters that the CD-ROM executable 
  204. file will need to run correctly. These are stored in a separate 
  205. section of QCD.INI for each CD-ROM in the format:
  206.         [CDx] - where x=sequential CD number in QCD.INI
  207.         u=1 (CD-ROM type is single executable file);
  208.         a=identifier file path:\filename 
  209.         x=executable file path:\filename
  210.         p=optional parameters
  211.         
  212. l.      If the CD-ROM is an archive only without an operating shell
  213. or other executable files, QLIB automatically creates an entry in 
  214. the format:
  215.         [CDx]
  216.         u=4
  217.         a=identifier file path:\filename
  218.         x=Search Archival Files
  219.         p=
  220.  
  221. m.      If the CD-ROM contains multiple executable files, QLIB 
  222. requests the same information as in k. above, as well as a working 
  223. title for each executable file. This then creates two new sections 
  224. of QCD.INI in the format:         
  225.          [CDx] - where x=sequential CD number in QCD.INI
  226.          u=2
  227.          a=identifier file path:\filename
  228.          
  229.          [CDxmenu]
  230.          title1=executable file path:\filename optional parameters
  231.          title2=... etc. for all the individual executable files
  232.          
  233.          If no optional parameter is specified, QLIB concatenates
  234. an ampersand ("&") following the executable file path:\filename as
  235. a place-holder.
  236.  
  237. n.      If the CD-ROM mixes executable and archival files, QLIB
  238. requests the same information as in m. above, and creates two new
  239. sections in QCD.INI in the format:
  240.         [CDx]
  241.         u=3
  242.         a=identifier file path:\filename
  243.         
  244.         [CDxmenu]
  245.         title1=executable file path:\filename optional parameters
  246.         title2=... etc. for all executable files
  247.         Search Archival Files=      
  248.  
  249. o.      At the completion of each successful installation, the index
  250. NCD for total number of CDs installed in the [main] section of QCD.INI
  251. is incremented by 1 - unless the new CD-ROM has been installed in 
  252. place of a prior deletion. A brief message window confirms successful
  253. installation. QLIB then asks if you wish to install or edit another 
  254. CD-ROM. The program exits if you click "No". "Yes" returns you to
  255. QDOC and to the full installation procedure from step c. above.
  256.          
  257. UNINSTALLING a CD-ROM:
  258.  
  259. p.      QLIB does not require you to place the CD-ROM to be uninstalled
  260. into the CD-ROM drive. Selecting the "Uninstall CD-ROM" option from 
  261. the main menu brings up a master menu (from CDLIST.INI) showing CD-ROM 
  262. index number and title for all CD-ROMs currently installed. Click 
  263. the mouse on the title of the CD-ROM you wish to be deleted from 
  264. QCD.INI and CDLIST.INI.
  265.  
  266. q.      QLIB asks you to confirm your selection for deletion. If 
  267. you click "yes" to confirm, QLIB proceeds to:
  268. -       back-up QCD.INI and CDLIST.INI in the QCD working directory 
  269. as QCD.REM and CDLIST.REM for recovery in case of malfunction;
  270. -       delete the [CDx] and [CDxmenu] sections from QCD.INI (x is 
  271. the CD-ROM index number);
  272. -       delete the CD-ROM title from the [installed] section of 
  273. CDLIST.INI and the [CDTitle] section of QCD.INI, in each case 
  274. replacing   the title after the index number with the place-holder 
  275. "Deleted";
  276. -       if not already present, creates a section [deleted] in 
  277. QCD.INI;
  278. -       increments the total number of deletions "nd=" in section 
  279. [deleted] of QCD.INI by 1; 
  280. -       adds a new line to the [deleted] section cross-referencing 
  281. the CD-ROM index number (x) to the corresponding value of the deletion 
  282. index (nd), in the form "del(nd)=x"; and
  283. -       confirms successful deletion.
  284.  
  285. r.      QLIB then asks if you wish to edit or install another CD-ROM. 
  286. Clicking "yes" returns you to the main operating menu of QLIB. Clicking
  287. "no" concludes the program.
  288.  
  289. s.      Installation of a new CD-ROM in place of one that has been 
  290. deleted reverses the order of operations in q, above. Specifically, 
  291. -       new [CDx] and (if appropriate) [CDxmenu] sections are built 
  292. in QCD.INI; 
  293. -       the new CD-ROM title is substituted for "Deleted" in [CDTitle]
  294. in QCD.INI and in [installed] in CDLIST.INI; 
  295. -       the index nd in the [deleted] section of QCD.INI decrements 
  296. by 1; 
  297. -       the last line for del(nd)=x is removed from the [deleted] 
  298. section of QCD.INI; and
  299. -       the index value x is assigned to the new CD-ROM.
  300.  
  301. EDIT EXISTING INSTALLATION:
  302.  
  303. t.      The basic menu structure for CD-ROM access is determined by 
  304. QLIB in the installation and removal routines already described. 
  305. QLIB allows all  CD-ROM installation parameters to be edited or 
  306. modified separately. These include modification of the CD-ROM title 
  307. and identifier file; modification of the title or path\fileneame 
  308. for individual  executable files; and addition of new executable 
  309. files or archival search capabilities or deletion of existing executable
  310. files or search capabilities in current installations. The sequence 
  311. steps and messages presented to the user are as described in sections 
  312. f through o, above, for installation of a new CD-ROM. The CD-ROM 
  313. whose installation is to be edited must be in the CD-ROM drive for 
  314. QLIB to run. At each step, QLIB prompts the user for confirmation 
  315. before making any modifications.
  316.  
  317.  
  318. COMPLETION and EXIT:
  319.  
  320. u.      When you complete your editing or installation operations, 
  321. QLIB resumes control to ask if you wish to change CD-ROMs and load 
  322. another. Click "No" to exit QLIB. 
  323.  
  324.         If you click "Yes", QLIB shells to QDOC (see c. above) so 
  325. you may review documentation if you wish. It then prompts for 
  326. selection   of a new editing or installation operation. If you 
  327. choose no new operation, QLIB terminates.
  328.                    
  329.                 ENJOY YOUR CD-ROMs!       
  330.